タイトルマクロ¶

正しいマニュアルページを生成するためには、これらの 3 つのマクロを この順番で書く必要がある。

.Dd Month day, year

文書の日付。

.Dt DOCUMENT_TITLE [section] [volume]

タイトルを大文字で。

.Os OPERATING_SYSTEM [version/release]

オペレーティングシステム (BSD).

ページレイアウトマクロ¶

セクションヘッダ、段落の終わり、リスト、表示など。

.Sh

セクションのヘッダ。 正しいヘッダは、現れる順に:

NAME

名前のセクション。 ‘.Nm’ , ‘.Fn’ , ‘.Nd’ などのマクロを含む。

SYNOPSIS

利用法。

DESCRIPTION

一般的な説明。オプションやパラメータの説明も含む。

RETURN VALUE

セクション 2 や 3 の関数コール。

ENVIRONMENT

環境変数を説明する。

FILES

内容に関係するファイル。

EXAMPLES

例やおすすめ。

DIAGNOSTICS

通常セクション 4 のデバイスインターフェースの診断用。

ERRORS

セクション 2 や 3 のエラーやシグナル処理。

SEE ALSO

相互参照や引用。

CONFORMING TO

可能なら標準への準拠。

HISTORY

標準が適用されていない場合は、 歴史的な内容を与えるべきである。

BUGS

瑕疵や警告。

other

筆者の判断でヘッダをあつらえてもよい。

.Ss

サブセクションのヘッダ。

.Pp

段落の区切り。 垂直スペース (一行)。

.D1

(D-one) Display-one インデントしてテキストを一行表示。

.Dl

(D-ell) Displey-one literal。 インデントしてリテラルなテキストを一行表示。

.Bd

表示ブロックの開始。 表示オプション:

-ragged

揃えない (両端は不揃い)。

-filled

揃える。

-literal

リテラルなテキストまたはコード。

-file name

指定された file を読んで表示する。

-offset string

オフセット表示。 受付ける string の値は:

left

ブロックを左に揃える (デフォルト)。

center

大まかなセンターマージン。

indent

定数幅の空白 6 つ (タブ 1 つ)。

indent-two

タブ 2 つ。

right

揃えブロックを右から 2 インチの位置に残す。

xxn

xx は 4n から 99n までの数字。

Aa

Aa は呼びだし可能なマクロの名前。

string

string の幅が用いられる。

.Ed

表示終了 (.Bd にマッチする)。

.Bl

リスト開始。 リストまたはコラムを生成する。オプションは以下:

リスト形式

-bullet	中黒のアイテムリスト
-item	ラベルなしリスト
-enum	数値付きリスト
-tag	タグラベル付きリスト
-diag	診断リスト (diagnostic list)
-hang	ぶらさがりラベルリスト
-ohang	飛び出しラベルリスト
-inset	ラベル付きリストの挿入・継続

リストパラメータ

-offset

(全てのリスト) 上記の ‘.Bd’ ディスプレイ開始 (begin-display) を見よ。

-width

(-tag および -hang リストのみ) ‘.Bd’. を見よ。

-compact

(全てのリスト) 空行を抑制する。

.El

リストの終わり。

.It

リスト項目。

マニュアルドメインマクロ¶

一般テキストドメインマクロ¶

‘q’ で終わる名前のマクロは、引数リストの残りの項目をクォートする。 ‘o’ で終わる名前のマクロは一行以上にわたる入力のクォートを開始し、 これは対応する名前の ‘c’ でおわる名前のマクロで終了する。 囲みマクロはネストでき、引数は 8 つまで取れる。

注意: 拡張引数リストマクロ (‘.Xo’, ‘.Xc’) および関数の囲みマクロ (‘.Fo’, ‘.Fc’) は変則である。 拡張リストマクロはマクロの引数が troff の制限である 9 個を越えるときに用いられる。

UR マクロ (URI/URL ハイパーテキスト参照の開始), UE マクロ (終了), UN マクロ (参照用ターゲットの指定) も利用できる。 これらのマクロに関するより詳しい情報は man(7) を見よ。